Inside Macintosh: QuickDraw GX Printing Extensions and Drivers /

Chapter 4 - Printing Messages / Printing Messages Reference

Printing Messages / Color Profile Messages

GXFindFormatProfile

QuickDraw GX sends the GXFindFormatProfile message to allow you to modify color matching information for a specific format object. This message is similar to the GXFindPrinterProfile message (described above), except that it finds a color profile that is associated with a format object rather than a printer object. Your override of the GXFindFormatProfile message must match the following formal declaration:

OSErr MyFindFormatProfile (gxFormat theFormat,
            void *searchData, long index,
            gxColorProfile *returnedProfile, long *numProfiles);

theFormat

The format object.

searchData

A pointer to a block of data that is assumed to be a ColorSync searching block of type CMProfileSearchRecord. If this value is not nil, then the value of the index parameter must not be 0 if you want the search to take place.

If this value is nil, the value of the index parameter defines which profile is returned.

index

The index of the profile to return. If the value is 0, then the current profile is returned in the returnedProfile parameter.

If the value of this parameter is not 0, then the behavior this function depends on the value of the searchData parameter. If index is not 0 and searchData is nil, the indexed profile is returned in the returnedProfile parameter. If index is not 0 and searchData is not nil, then the printer profiles are searched.

returnedProfile

On return, a color profile matching the criteria specified by the searchData and index parameters. If no color profiles are found, this value is nil upon return.

numProfiles

On return, the number of profiles that were found.

function result

An error code. The value noErr indicates that the operation was successful.

DESCRIPTION

When an application calls the GXFindFormatProfile function to search for a color profile that matches certain specficiations, QuickDraw GX sends the GXFindFormatProfile message to allow your printing extension or printer driver to modify the search criteria or results.

The default implementation of the GXFindFormatProfile message checks the profile that is associated with the specified format object. If no profile match is made, it then checks the profile that is associated with the color profile ('prof') resource that is stored with the desktop printer. If no profile is match, it then checks the profile that is associated with the color profile resource that is stored with the printer driver. If no match is made, then nil is returned in the returnedProfile parameter. You can override this message to change the profile matching data prior to forwarding the message or to modify the match results after forwarding the message.

RESULT CODES

gxSegmentLoadFailedErr	A required code segment could not be found, or there was not enough memory to load it.
gxPrUserAbortErr	The user has canceled printing.

SEE ALSO

The GXFindFormatProfile function is described in Inside Macintosh: QuickDraw GX Printing.

Color matching, color profiles, the CMProfileSearchRecord structure, and color profile resources are described in Inside Macintosh: Advanced Color Imaging.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help